Webhooks

You can manage state synchronization by using API queries to the LetsGetChecked resources.

A webhook notification is like an API driven by events rather than requests. An API requests other API's endpoints to receive a response, but a webhook allows one program to send data to another as soon as a particular event occurs. They deliver real-time updates to your application as soon as the updates are available and are less resource intensive than APIs.

Configuring webhook notifications

Webhook notifications are triggered in real-time for any status update on orders and results resources, and also for outreach notifications.

Webhook notifications may have a callback URL so that your organization's application can query for details on the event. These can be, for example, the fulfillment of an order or returning results. For more information, see the Payload structure.

These notifications will be sent to endpoints provided by you, hence you can provide a single webhook destination endpoint or, for example, a different endpoint for each webhook type. For more on webhook types, check Event types.

To learn how you can configure webhooks securely, see Authentication for submitted payloads.